CDDCParams Class Reference

#include <CDDCParams.h>

Inherits NSObject.

Public Types
enum	OptionalRetrievableFields { OptionalRetrievableFieldsBluetooth = 0 , OptionalRetrievableFieldsGeolocation }

Instance Methods
(long)	- refreshDurationSeconds
(BOOL)	- setRefreshDurationSeconds:error:
(NSSet< NSNumber * > *)	- optionalRetrievableFields
(BOOL)	- addOptionalRetrievableField:error:
(BOOL)	- setOptionalRetrievableFields:error:

Detailed Description

An CDDCParams object provides parameters for CDDC process.

Member Enumeration Documentation

OptionalRetrievableFields

- (enum) OptionalRetrievableFields

List of all optional fields requiring user permissions

Enumerator
OptionalRetrievableFieldsBluetooth	Retrieve Bluetooth information
OptionalRetrievableFieldsGeolocation	Retrieve geolocation information

Method Documentation

addOptionalRetrievableField:error:

- (BOOL) addOptionalRetrievableField:		(OptionalRetrievableFields)	field
error:		(NSError **)	error

Add a field to the list of fields to be automatically retrieved and that require permissions.

Parameters

field	new field to add
error	a NSError raised if there is an error during the process.

Returns

true if the call is successful, If an error occurred the reason will be put in the error.

optionalRetrievableFields

- (NSSet< NSNumber * > *) optionalRetrievableFields

Gets the current list of fields for automatic retrieval that require permissions.

Returns

list of configured fields

refreshDurationSeconds

- (long) refreshDurationSeconds

Gets the current CDDC refresh delay in seconds.

Returns

current refresh delay (in seconds), default value is 60

setOptionalRetrievableFields:error:

- (BOOL) setOptionalRetrievableFields:		(NSSet< NSNumber * > *)	optionalRetrievableFields
error:		(NSError **)	error

Sets the list of fields to be automatically retrieved and that require permissions.

Parameters

optionalRetrievableFields	new field list
error	a NSError raised if there is an error during the process.

Returns

true if the call is successful, If an error occurred the reason will be put in the error.

setRefreshDurationSeconds:error:

- (BOOL) setRefreshDurationSeconds:		(long)	duration
error:		(NSError **)	error

Sets the refresh delay for the automatic CDDC data collection. If the delay was not set manually, default value is 60 seconds.

Parameters

duration	new refresh delay (in seconds)
error	a NSError raised if there is an error during the process.

Returns

true if the call is successful, If an error occurred the reason will be put in the error.

---

The documentation for this class was generated from the following file:

• CDDCParams.h